Fzzy Config/me.fzzyhmstrs.fzzy_config.validation.minecraft/ValidatedTagKey

ValidatedTagKey

open class ValidatedTagKey<T : Any> @JvmOverloads constructor(defaultValue: TagKey<T>, predicate: Predicate<Identifier>? = null) : ValidatedField<TagKey<T>>

A validated TagKey

By default, validation will allow any TagKey currently known by the registry of the provided default Tag.

Author

fzzyhmstrs

Since

0.2.0

Parameters

the TagKey type

defaultValue

TagKey - the default tag

predicate

Predicate<Identifier>, Optional - use to restrict the allowable tag selection

Samples

import com.google.common.collect.ArrayListMultimap
import me.fzzyhmstrs.fzzy_config.validation.minecraft.ValidatedEntityAttribute
import me.fzzyhmstrs.fzzy_config.validation.minecraft.ValidatedIngredient
import me.fzzyhmstrs.fzzy_config.validation.minecraft.ValidatedTagKey
import net.minecraft.entity.attribute.EntityAttribute
import net.minecraft.entity.attribute.EntityAttributeModifier
import net.minecraft.recipe.Ingredient
import net.minecraft.registry.tag.BlockTags
import net.minecraft.registry.tag.ItemTags
import net.minecraft.util.Identifier

fun main() { 
   //sampleStart 
   //validated block tag that allows any tag in the Block Registry
val validatedTag = ValidatedTagKey(BlockTags.ACACIA_LOGS)

//validated Item TagKey with a predicate on the various tool types (this is optional)
val validatedTagPredicated = ValidatedTagKey(ItemTags.AXES) { id ->
    listOf(
        ItemTags.AXES.id,
        ItemTags.SWORDS.id,
        ItemTags.SHOVELS.id,
        ItemTags.HOES.id,
        ItemTags.PICKAXES.id
    ).contains(id)
}

//fields and sections have lang keys based on their "location" in the Config class graph.
//Lang key composition is as follows
//1. the namespace of the config id: (my_mod)
//2. the path of the config id: (my_mod.my_config)
//3. any parent ConfigSection field names as declared in-code: (my_mod.my_config.subSection)
//4. the setting field name as declared in-code: (my_mod.my_config.subSection.fieldName)
val fieldLang = """
{
    "_comment1": "the lang for an example 'fieldName' setting in a config inside section 'subSection'",
    "my_mod.my_config.subSection.fieldName": "Very Important Setting",
    "my_mod.my_config.subSection.fieldName.desc": "This very important setting is used in this very important way."
}
""" 
   //sampleEnd
}

Constructors

ValidatedTagKey

@JvmOverloads

constructor(defaultValue: TagKey<T>, predicate: Predicate<Identifier>? = null)

Functions

open override fun accept(input: TagKey<T>)

updates the wrapped value. NOTE: this method will push updates to an UpdateManager, if any. For in-game updating consider validateAndSet

addListener

open fun addListener(listener: Consumer<ValidatedField<TagKey<T>>>)

Attaches a listener to this field. This listener will be called any time the field is written to ("set"). accept, validateAndSet, setAndUpdate and so on will all call the listener.

andThen

open fun andThen(p0: Consumer<in TagKey<T>>): Consumer<TagKey<T>>

codec

fun codec(): Codec<TagKey<T>>

Provides a Codec representing the value type of this validation, backed by the validators within as applicable

copyStoredValue

open override fun copyStoredValue(): TagKey<T>

Creates a deep copy of the stored value and returns it

correctEntry

open override fun correctEntry(input: TagKey<T>, type: EntryValidator.ValidationType): ValidationResult<TagKey<T>>

description

open fun description(fallback: String? = null): MutableText

The translated Text description from the descriptionKey. Falls back to an empty string so no tooltip is rendered.

descriptionKey

open override fun descriptionKey(): String

translation key of this Translatable's description. the "description" in-game, the descriptions Enchantment Descriptions adds to enchantment tooltips are a good example.

flags

open fun flags(): Byte

get

open override fun get(): TagKey<T>

supplies the wrapped value

getDefault

fun getDefault(): TagKey<T>

Provides this validations default value

hasDescription

open fun hasDescription(): Boolean

Whether this Translatable has a valid description

hasFlag

open override fun hasFlag(flag: EntryFlag.Flag): Boolean

hasTranslation

open fun hasTranslation(): Boolean

Whether this Translatable has a valid translation

instanceEntry

open override fun instanceEntry(): ValidatedField<TagKey<T>>

creates a deep copy of this ValidatedTagKey return ValidatedTagKey wrapping a deep copy of the currently stored tag and predicate

map

fun <N> map(to: Function<TagKey<T>, out N>, from: Function<in N, TagKey<T>>): ValidatedField<N>

Maps this validation to a new convertible type. The default value will be applied from this delegates current storedValue

fun <N> map(defaultValue: N, to: Function<TagKey<T>, out N>, from: Function<in N, TagKey<T>>): ValidatedField<N>

fun <N> map(to: Function<TagKey<T>, out N>, from: Function<in N, TagKey<T>>, defaultValue: TagKey<T>): ValidatedField<N>

Maps this validation to a new convertible type.

toCondition

open fun toCondition(condition: ValidatedField<Boolean>, fallback: Supplier<TagKey<T>>): ValidatedCondition<TagKey<T>>

Convert this field to a ValidatedCondition using the provided validation as a supplier. The provided condition (and any others you append) must pass for the stored value to be provided, otherwise the fallback will be supplied.

open fun toCondition(condition: ValidatedCondition.Condition, fallback: Supplier<TagKey<T>>): ValidatedCondition<TagKey<T>>

open fun toCondition(condition: Supplier<Boolean>, failMessage: Text, fallback: Supplier<TagKey<T>>): ValidatedCondition<TagKey<T>>

Convert this field to a ValidatedCondition. The provided condition (and any others you append) must pass for the stored value to be provided, otherwise the fallback will be supplied.

open fun toCondition(scope: String, failMessage: Text, fallback: Supplier<TagKey<T>>): ValidatedCondition<TagKey<T>>

Convert this field to a ValidatedCondition using the provided scope with a default boolean provider. The provided condition (and any others you append) must pass for the stored value to be provided, otherwise the fallback will be supplied. The provided scope must point to a valid boolean config scope otherwise the initial condition will never pass.

toList

fun toList(vararg elements: TagKey<T>): ValidatedList<TagKey<T>>

wraps the provided values into a ValidatedList with this field as validation

fun toList(collection: Collection<TagKey<T>>): ValidatedList<TagKey<T>>

wraps the provided collection into a ValidatedList with this field as validation

toSet

fun toSet(vararg elements: TagKey<T>): ValidatedSet<TagKey<T>>

wraps the provided values into a ValidatedSet with this field as validation

fun toSet(collection: Collection<TagKey<T>>): ValidatedList<TagKey<T>>

wraps the provided collection into a ValidatedList with this field as validation

translation

open override fun translation(fallback: String?): MutableText

The translated Text name from the translationKey. Falls back to the implementing classes Simple Name (non-translated)

translationKey

open override fun translationKey(): String

translation key of this Translatable. the "name" in-game

trySerialize

fun trySerialize(input: Any?, errorBuilder: MutableList<String>, flags: Byte): TomlElement?

trySet

open override fun trySet(input: Any?)

update

open fun update(updateMessage: Text)

validateAndSet

open fun validateAndSet(input: TagKey<T>): ValidationResult<TagKey<T>>

A setter method for the storedValue that first validates the value being set and then stores the post-validation result.

validateEntry

open override fun validateEntry(input: TagKey<T>, type: EntryValidator.ValidationType): ValidationResult<TagKey<T>>

widgetAndTooltipEntry

open fun widgetAndTooltipEntry(choicePredicate: ChoiceValidator<TagKey<T>> = ChoiceValidator.any()): ClickableWidget